invgate-ux

(0 reviews)

Update Notes or Comments

/{businessId}/troubleTicket/{id}

[PATCH]

To update the notes or comments in salesforce from InvGate.

URL
https://nonprod.lc.esb.cloud.lla.com/test/invgate-ux-lc/invgate-ux/v1/{businessId}/troubleTicket/{id}
Url Param
nametypedescriptionrequired
businessIdstringExpected: HN,CO,CR,SV,GT,DO,TT,BB,JM,AG,AI,DM,GD,LC,VC,TC,MS,VGY
idstringSalesforce IdY
Headers
nametypedescriptionrequired
client_idstringClient Id value for Client Id Enforcement policy. Environment Specific Value. Eg: 6f0ed16a7b494d76b2d60e05bc3b3332Y
client_secretstringClient secret value for Client Id Enforcement policy. Environment Specific Value, eg: e4CD4D43449846aA9D8Cb9c43fAd324aY
X-Correlation-IDstringThis is a unique identifier. Could be uuid value, Min 16 Characters Syntax: correlationId: uuid:cwc--, example: X-Correlation-ID: f058ebd6-02f7-4d3f-942e-904344e8cde7:cwc--qacarepcN
Salesforce tenants
SF Environment to ConnectSF Instance
QAcwc--qa
UATcwc--uatsfdc
Productioncwc--prod
Body Definitions
nametypedescriptionrequired
@typestringDefault: NetworkTroubleTicketY
ticketTypestringType of incident Expected: Incident,Service Request,Change RequestY
externalIdstringInvgate Ticket IdN
note[].textstringNotes descrpiton and Notes details seperated with pipe symbolN
note[].@typestringDefault : NoteN
attachment[].mimeTypestringType of attachmentN
attachment[].namestringName of attachmentN
attachment[].contentstringBase64 content of attachmentN
attachment[].attachmentTypestringDefault to "WorklogAttachments"N
attachment[].@referredTypestringDefault : AttachmentN
Sample Request
{
 "ticketType":"",
 "externalId":"",
 "note": [
      {
         "text":"<notes descrption>|<notes details>",
         "@type":"Note"
      }
   ],
   "attachment": [
          {
            "mimeType": "text/plain",
            "name": "ModemImage.txt",
            "content": "<base64 content>",
            "attachmentType": "WorklogAttachments",
            "@referredType": "Attachment"
          }
    ],
   "@type":"NetworkTroubleTicket"
}
Success Response
{
 "ticketType":"",
 "externalId":"",
 "note": [
      {
         "text":"<notes descrption>|<notes details>",
         "@type":"Note"
      }
   ],
   "attachment": [
          {
            "mimeType": "text/plain",
            "name": "ModemImage.txt",
            "content": "<base64 content>",
            "attachmentType": "WorklogAttachments",
            "@referredType": "Attachment"
          }
    ],
   "@type":"NetworkTroubleTicket"
}

Reviews